Skip to content

docs(handoff): add local↔cloud handoff documentation#85

Merged
hongyi-chen merged 16 commits into
hyc/orchestration-launchfrom
hyc/orch/handoff
May 19, 2026
Merged

docs(handoff): add local↔cloud handoff documentation#85
hongyi-chen merged 16 commits into
hyc/orchestration-launchfrom
hyc/orch/handoff

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

@hongyi-chen hongyi-chen commented May 16, 2026

Adds documentation for the Handoff feature shipping with the Oz Orchestration Launch (Maestro). Three new pages under a new agent-platform/cloud-agents/handoff/ directory cover the local↔cloud and cloud↔cloud handoff directions, plus an overview of what's preserved across a handoff. Cloud-to-local routes to the existing Viewing cloud agent runs page — the Continue locally affordance and /continue-locally slash command are already documented there, and there isn't a dedicated cloud-to-local procedural in this PR.

New pages

  • src/content/docs/agent-platform/cloud-agents/handoff/index.mdx — Conceptual overview: what handoff is, the three directions it supports, third-party agent runtime coverage, what carries over (conversation history, workspace state, conversation attachments), and when to use each direction.
  • src/content/docs/agent-platform/cloud-agents/handoff/local-to-cloud.mdx — Procedural: promoting a local Warp Agent conversation to a cloud agent run via the & shortcut or /handoff slash command, including prerequisites, the workspace snapshot mechanics, and troubleshooting.
  • src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx — Procedural: sending a follow-up to an ended cloud run so the run continues with the prior session's workspace state restored. Covers the Warp Agent flow, the third-party agent runtime Continue-button flow, and the per-session run identity model.

Resolved review threads

  • @oz-for-oss (importance: 3 items) — addressed in commits e1da8dd, 91cd3da, and e6bfba8. Scoped the snapshot mechanism to local↔cloud and cloud↔cloud (not cloud→local). Dropped the inaccurate git diff --binary HEAD claim. Softened the local-to-cloud entry point to & / /handoff only (with an explicit note that /cloud-agent is not a handoff entry point).
  • @captainsafia (9 items) — addressed in commit e4bdd4b. Highlights: collapsed the duplicate "ambient agent run" bullet on the overview, called out the local→cloud handoff permission constraint, removed surfaces (Oz web app, API) that don't currently send follow-ups, and pinned per-session timestamps to the transcript rather than the API.
  • @rachaelrenk (9 suggested edits + 1 PR-level note) — addressed in commit b45a4e8. User-facing terminology ("Warp session" instead of "Warp terminal", "third-party agent runtimes" instead of "harnesses"), direct Oz web app deep links to the Runs page, sentence-case nav text consistency, and minor copy polish.

Final senior-copywriter pass (commit b45a4e8)

On top of Rachael's suggestions, applied the same patterns to cloud-to-cloud.mdx for consistency:

  • "Use this handoff direction when:" framing.
  • Direct Oz web app Runs-page deep link in Step 1.
  • Sentence-case Related-pages link text.
  • Removed a stray duplicate ### Third-party harnesses heading that was sitting above the correct ### Third-party agent runtimes heading, and fixed a missing blank line before the next ## section.

Validation

  • python3 .agents/skills/style_lint/style_lint.py --changed — clean (0 issues).
  • python3 .agents/skills/check_for_broken_links/check_links.py --internal-only — clean (2,439 internal links across 321 files).

File scope

Strictly within the listed handoff pages. No edits to src/sidebar.ts, vercel.json, or any top-level/cross-cutting landing pages — those are reserved for the follow-up sidebar PR.

For the engineering reviewer

  • Feature-flag posture. local_to_cloud_handoff and cloud_to_cloud_handoff are not set in prod.yaml today (only staging/local); OzHandoff is in DOGFOOD_FLAGS. The pages assume these are on at launch — confirm before merging.
  • Sidebar registration. New pages won't appear in the sidebar until the cross-cutting sidebar PR lands.

Co-Authored-By: Oz oz-agent@warp.dev

Add a new handoff section under cloud-agents that documents the three
directions of handoff supported by the orchestration launch:

- Overview (conceptual) explaining what handoff is, the three
  directions, and what carries over.
- Local→cloud (procedural) for promoting a local Warp Agent
  conversation to a cloud agent run.
- Cloud→local (procedural) for picking up a cloud run inside the
  Warp terminal via /continue-locally and equivalent UI entrypoints.
- Cloud→cloud (procedural) for follow-ups that span multiple
  executions of the same run.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 16, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 19, 2026 6:09am

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 16, 2026

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds four new handoff documentation pages covering local-to-cloud, cloud-to-local, cloud-to-cloud, and an overview. The structure is useful, but a few statements overpromise current behavior or document an unconfirmed/incorrect user flow, which could mislead users at launch.

Concerns

  • The overview describes all handoff directions as sharing workspace-snapshot rehydration, but the cloud-to-local page says local continuation only forks the conversation and artifacts.
  • The local-to-cloud procedure publishes a specific /cloud-agent/shortcut handoff flow even though the client surface needs confirmation.
  • The local-to-cloud page says git diff --binary HEAD captures untracked changes, which that command does not do by itself.

Verdict

Found: 0 critical, 3 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/local-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/local-to-cloud.mdx Outdated
Address PR review feedback and Slack-thread direction.

- Drop cloud-to-local.mdx; existing fork-to-local docs in
  viewing-cloud-agent-runs.mdx already cover the capability. Overview
  now references that page for cloud-to-local.
- Scope the snapshot rehydration mechanism in the overview to
  local-to-cloud and cloud-to-cloud only; cloud-to-local does not
  apply workspace patches.
- Replace the inaccurate `git diff --binary HEAD` capture description
  in local-to-cloud with a high-level summary that covers tracked and
  untracked changes without committing to a specific git command.
- Soften the local-to-cloud entry point: do not document a specific
  keyboard shortcut, add a note that the affordance may evolve during
  the Oz launch rollout.
- Strip internal-only details from user-facing copy: GCS paths,
  manifest filenames, `git apply` mechanics, internal routing names
  (appended/injected/requeued), API endpoint paths, and rehydration
  checklist references.
- Senior-writer pass: tighten descriptions to 50-160 chars, reduce
  marketing fluff, normalize cross-references.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen
Copy link
Copy Markdown
Collaborator Author

Revision pass

Pushed e1da8dd to address PR-review feedback, Slack-thread direction, and an internal-only/senior-writer scrub.

What changed

  • Dropped cloud-to-local.mdx per Slack feedback (cloud → local is not new functionality at launch). The existing fork-to-local capability is already documented at viewing-cloud-agent-runs.mdx, and the new /continue-locally slash command is in the changelog. The overview now references that page for the cloud-to-local direction.
  • Rewrote index.mdx to scope the snapshot rehydration mechanism to local-to-cloud and cloud-to-cloud only — cloud-to-local does not apply workspace patches.
  • Rewrote local-to-cloud.mdx to drop the inaccurate git diff --binary HEAD capture description and to soften the entry point (no specific keyboard shortcut, with a note that the affordance may evolve during launch).
  • Rewrote cloud-to-cloud.mdx to reframe the routing logic in user-facing terms instead of the internal appended / injected / requeued names.

Review comments addressed

  • ✅ Scope the GCS-snapshot + git apply mechanism in the overview — cloud-to-local is now carved out, and the snapshot mechanism is described in user-facing terms without git apply.
  • git diff --binary HEAD claim in local-to-cloud — replaced with a high-level description that covers tracked and untracked changes.
  • ✅ Confirm the /cloud-agent + shortcut entry point — softened to "the cloud agent launch flow" with /cloud-agent as an example. No keyboard shortcut. Added a :::note noting the affordance may evolve.

Internal-only scrub

Stripped from all user-facing copy: GCS paths (handoff/{token}/, snapshots/{run_id}/{execution_id}/), manifest filenames (snapshot_state.json), internal type names, API endpoint paths, internal routing names, and git apply mechanics.

Validation

  • style_lint --changed — clean
  • check_links --internal-only — clean (2,416 internal links across 320 files)

Open questions for PM

  • Feature-flag posture. local_to_cloud_handoff and cloud_to_cloud_handoff are not set in prod.yaml today (only in staging/local). OzHandoff is in DOGFOOD_FLAGS. The pages assume these flip on at launch — confirm before merging.
  • Local-to-cloud entry point. The procedural describes "the cloud agent launch flow inside an active conversation" without a specific shortcut. If the shipped UX uses a dedicated affordance (e.g. a button or a different slash command), update step 1 in local-to-cloud.mdx.
  • Sidebar registration. New pages still won't appear in the sidebar until the cross-cutting sidebar PR lands.

- Replace 'execution' with 'session' across cloud-to-cloud.mdx so the
  user-facing unit of work stays 'the run', not the internal model.
- Drop 'rehydrate'/'rehydration' in favor of 'restore'/'carry over';
  fold the standalone 'Rehydration behavior' section into 'What carries
  over' in the overview.
- Drop the 'server-side' qualifier on 'fork' throughout; users don't
  care where the fork happens.
- Collapse the cloud-to-cloud 'How follow-ups route' state-machine
  into a single user-facing description; remove the two routing-paths
  items from troubleshooting since they describe normal behavior, not
  problems.
- Collapse local-to-cloud's 'Verifying the handoff' debugging
  walkthrough into one sentence pointing readers to the management
  view.
- Cut meta self-descriptions: 'The handoff entry point is integrated
  into the cloud agent launch flow...' and 'Cloud-to-cloud handoff is
  automatic...'.
- Drop the rollout caveat note on local-to-cloud.
- Reduce 'sandbox' references where they leak infrastructure.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen
Copy link
Copy Markdown
Collaborator Author

Second editor pass

Pushed 91cd3da with a more aggressive scrub of internal jargon and structural over-explanation. Net: −75 lines / +40 lines across the three pages.

Terminology

  • executionsession (or removed) — A run has many sessions in the user's mental model, not many executions. The internal model is no longer leaking.
  • rehydrate / rehydrationrestore / "carry over" — User-facing language only.
  • server-side forkfork — Readers don't care where the fork happens.
  • sandbox — Trimmed where it leaked infrastructure; kept where it adds clarity.

Structural changes

  • Folded the standalone Rehydration behavior section in the overview into What carries over.
  • Collapsed cloud-to-cloud's How follow-ups route state-machine (queued / alive / ended) into a single user-facing description. Those routing branches are implementation detail; the user reality is "send a follow-up and the run continues."
  • Removed two cloud-to-cloud troubleshooting items that described the appended and live-session routing paths — they're normal behavior, not problems.
  • Collapsed local-to-cloud's Verifying the handoff debugging walkthrough into one sentence pointing readers to the management view.
  • Cut self-descriptive meta sentences ("The handoff entry point is integrated…", "Cloud-to-cloud handoff is automatic…").
  • Dropped the rollout caveat note on local-to-cloud.

Validation

  • style_lint --changed — clean (3 files, 0 issues)
  • check_links --internal-only — clean (2,416 internal links across 320 files)
  • Final grep for rehydrat, server-side, execution, sandbox in the handoff pages — zero hits.

- cloud-to-cloud.mdx: soften per-session timeline claim to API-only (UI render not present)
- cloud-to-cloud.mdx: gloss 'ambient agent task' inline for clarity
- local-to-cloud.mdx: switch primary credits link to credits page; fix link text casing for access page

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen
Copy link
Copy Markdown
Collaborator Author

Applied audit fixes for handoff pages. Summary of changes:

  • cloud-to-cloud.mdx (line 56) — Softened the per-session timeline UI claim to API-only phrasing. Verified warp-internal/app/src/ai/agent_management/* and conversation_details_panel.rs show only aggregated Credits/Run time/Created on in the detail pane, with no per-session breakdown rendered. The execution data is available via the API.
  • cloud-to-cloud.mdx (line 24) — Kept the compute rollup claim. Verified in warp-server/logic/ai/ambient_agents/billing/compute.go: per-execution credits accumulate onto the task total.
  • cloud-to-cloud.mdx (line 16) — Added an inline gloss for "ambient agent run" (described as "an agent that runs in the background, such as a scheduled or integration-triggered run") to orient readers without duplicating the bullet above.
  • local-to-cloud.mdx (line 35) — Switched the primary credits-prereq link to /support-and-community/plans-and-billing/credits/ so individual users get an accurate target, with a secondary link to /agent-platform/cloud-agents/team-access-billing-and-identity/ for team-specific requirements. Also corrected the link text casing to match the page's sidebar label ("Access, billing, and identity").
  • Validation: style_lint --changed and check_links --internal-only both clean.

Co-authored-by: Oz oz-agent@warp.dev

Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/local-to-cloud.mdx Outdated
@captainsafia
Copy link
Copy Markdown

Some other thoughts that are not aligned with existing content:

  • We should clarify that cloud-cloud handoff is available for 3P harnesses but the UI is a little different (click continue then provide input).
  • Local-cloud is not available for 3P harnesses.

- index.mdx: drop launch-anchored framing; reframe Directions list as
  evergreen capability statement; add third-party-harness coverage
  subsection (cloud<->cloud works on 3P with Continue+input prompt;
  local->cloud is Warp Agent only).
- local-to-cloud.mdx: replace /cloud-agent entry-point claim with the
  '&' shortcut and the '/handoff' slash command; add note that the
  model can't be changed during handoff.
- cloud-to-cloud.mdx: consolidate duplicate scheduled/integration
  bullets; add 'same Git branch' detail to workspace-state carryover;
  add :::caution that handoff requires a prior-execution snapshot;
  note that local->cloud-originated runs can only be continued by
  the creating user; scope send-follow-up to the Warp app and drop
  the Oz-web-app/integration follow-up sections; add third-party
  harness Continue-button flow; soften per-execution timeline claim
  (transcript is the source of truth, not the API).

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen
Copy link
Copy Markdown
Collaborator Author

Some other thoughts that are not aligned with existing content:

  • We should clarify that cloud-cloud handoff is available for 3P harnesses but the UI is a little different (click continue then provide input).
  • Local-cloud is not available for 3P harnesses.

Both points addressed in this pass:

  • index.mdx now has a Third-party harness coverage subsection directly under "Directions of handoff" that calls out cloud↔cloud works on third-party harnesses with a Continue button + input prompt (vs. the streamlined follow-up flow on the Warp Agent), and that local→cloud is Warp Agent only.
  • cloud-to-cloud.mdx has a dedicated Third-party harnesses subsection under "Sending a follow-up" describing the Continue + input-prompt flow, pointing at the conversation details panel and end-of-run tombstone as surfaces.

@hongyi-chen hongyi-chen requested a review from captainsafia May 18, 2026 22:57
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed for the same patterns we covered in PRs #83 and #84: user-facing terminology, direct Oz web app links, sentence-case consistency, and launch-surface/eligibility clarity. One PR-level note: the PR description still says there are four new handoff pages including a dedicated cloud-to-local page, but the current file list has three new pages and routes cloud-to-local to the existing viewing-cloud-agent-runs page. It may be worth updating the PR description or confirming whether a dedicated cloud-to-local page is still expected before merge.

Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/index.mdx
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Comment thread src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx Outdated
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving but left comments + suggested edits

…cloud.mdx

Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com>
Apply all 9 of @rachaelrenk's suggested edits on PR #85 and run a final
senior-copywriter pass for consistency across the three handoff pages.

index.mdx
- Intro: "your local Warp terminal" -> "a local Warp session" so the
  intro talks about a session rather than the terminal application.
- "Third-party harness coverage" -> "Third-party agent runtime
  coverage"; same swap in the two bullets underneath. "Harness" is
  internal vocabulary; "agent runtime" is the user-facing term.
- "spiraled into work" -> "grown into work" (less idiomatic).
- "Managing Cloud Agents" -> "Managing cloud agents" in Related pages
  to match the sentence-case nav style used elsewhere.
- Consistency polish: "Fork a cloud conversation into your local
  terminal" -> "into a local Warp session" so the cloud-to-local
  bullet uses the same terminology as the rewritten intro.

local-to-cloud.mdx
- Intro: "Hand off a conversation from the Warp terminal" -> "Hand off
  a local Warp conversation" (same reason as above).
- "This direction is the right move when:" -> "Use this handoff
  direction when:" (less conversational, matches docs voice).
- Post-handoff pointer: linked the management view doc -> deep-linked
  the [Runs page](https://oz.warp.dev/runs) in the Oz web app, which
  matches the pattern added in PR #84.
- "Cloud Agents quickstart" -> "Cloud agents quickstart" (sentence
  case).

cloud-to-cloud.mdx (consistency polish, same patterns Rachael called
out in the other two pages)
- "This direction is the right move when:" -> "Use this handoff
  direction when:".
- Step 1 of "Sending a follow-up": linked the management view doc ->
  deep-linked the Runs page in the Oz web app.
- Removed a stray duplicate `### Third-party harnesses` heading that
  was sitting directly above the correct `### Third-party agent
  runtimes` heading, and inserted a missing blank line before the
  next `## Inspecting a run that's been handed off` section.
- "Managing Cloud Agents" -> "Managing cloud agents" in Related pages.

Validation
- python3 .agents/skills/style_lint/style_lint.py --changed -> 0 issues.
- python3 .agents/skills/check_for_broken_links/check_links.py --internal-only
  -> 0 broken links (2,439 internal links across 321 files).

Co-Authored-By: Oz <oz-agent@warp.dev>
A senior-copywriter follow-up on commit b45a4e8. Focuses on terminology
consistency, list parallelism, active voice, and a few style-guide nits
caught on the second read.

index.mdx
- Frontmatter description: "Move an agent conversation between your
  terminal and the cloud" -> "Move agent work between a local Warp
  session and the cloud" so the description matches the body intro
  (which Rachael's review moved to "local Warp session" terminology).
- "Directions of handoff" Local-to-cloud bullet: "more compute,
  longer-running work, or to fan out variants in parallel" ->
  "more compute, longer-running work, or parallel variants of the
  same task". Now all three list items are parallel noun phrases.
- "Workspace state" bullet: "The cloud-to-local direction does not
  currently apply" -> "doesn't currently apply" (contractions are
  encouraged in the style guide for an approachable tone).

local-to-cloud.mdx
- "Use this handoff direction when:" list: first bullet started with
  "The task is going to run for a long time..." while the other three
  start with "You want...". Rewrote it to "You have a long-running
  task and don't want to keep your laptop awake." so all four bullets
  open the same way.
- Step 1: "trigger handoff with the `&` shortcut or the `/handoff`
  slash command" -> "press `&` or run the `/handoff` slash command".
  Direct verbs match the style guide pattern for keyboard / slash
  commands.
- Step 2: "Pick the environment whose..." -> "Pick the one whose..."
  (avoids repeating "environment" right after the bold header).
  "create one first and add" -> "create one and add" ("first" was
  doing no work).
- Post-steps prose: "After submission, the cloud agent applies your
  workspace snapshot" -> "After you submit, the cloud agent...".
  Active voice; readers don't talk about "submission."
- Troubleshooting (uncommitted changes): "Without it, the
  conversation can't be forked" -> "Otherwise, the conversation can't
  be forked". "Without it" had a fuzzy antecedent; "Otherwise" reads
  cleanly off the preceding sentence.

cloud-to-cloud.mdx
- "Use this handoff direction when:" list: first bullet "A cloud
  agent finished and you want to send a follow-up after the session
  has ended." -> "You want to send a follow-up to a cloud agent
  after its session has ended." Now parallel with the second bullet
  ("You want to continue an ambient agent run...").
- Cleaned up three lingering uses of "execution" that the earlier
  internals scrub missed. All three were re-introduced when applying
  Safia's audit-fix feedback in e4bdd4b. Replaced with "session":
    - "the new execution runs on the same Git branch as the prior
      session" -> "the new session continues on the same Git branch"
      (avoids both the internal term and the "new ... prior" cycle).
    - ":::caution Cloud-to-cloud handoff relies on a snapshot from
      the prior execution" -> "...the prior session".
    - "Click into the run to see the full transcript: each
      execution appears in order, and you can scan the transcript to
      see where one execution ended and the next began. Per-execution
      timestamps aren't currently exposed in the API..." -> all three
      "execution"s -> "session" / "Per-session".
- "What carries over" trailing sentence: "...proceeds with what it
  could before continuing to your follow-up." -> "...rather than
  starting over silently." Now parallel with the same sentence on
  the other two handoff pages.
- "Sending a follow-up" lead-in: dropped the orphan third sentence
  ("Send-follow-up support is available in the Warp app.") and
  folded it into the first: "you send a follow-up from the Warp app,
  and the run continues."
- Step 2: "Type the next message into the conversation's input" ->
  "Enter the next message in the conversation's input" ("Enter" is
  the style guide's verb for text fields).
- Troubleshooting (old runs): "Start a new cloud agent run with the
  prompt you want and reference the prior run in the prompt if
  needed." -> "Start a new cloud agent run with the prompt you want,
  referencing the prior run if needed." (drops the "prompt"
  repetition).

Final grep over the handoff folder for "execution", "harness",
"spiraled", "right move", "Cloud Agents", "Warp terminal" -> zero hits.

Validation
- python3 .agents/skills/style_lint/style_lint.py --changed -> 0 issues.
- python3 .agents/skills/check_for_broken_links/check_links.py --internal-only
  -> 0 broken links (2,439 internal links across 321 files).

Co-Authored-By: Oz <oz-agent@warp.dev>
I missed two of @rachaelrenk's review comments on the cloud-to-cloud
page in earlier passes because they weren't returned by the first
`gh pr view` query. Applying them now.

cloud-to-cloud.mdx
- "ambient agent run" -> "background cloud agent run". Rachael flagged
  "ambient agent run" as abstract/internal-feeling; "background cloud
  agent run" keeps the example concrete and matches the user-facing
  framing on the surrounding pages. Per her suggested edit verbatim.
- Removed `blocked` from the example list of terminal states. The API
  treats BLOCKED as terminal for cancellation purposes, but the spec
  describes it as "awaiting user input or approval" — so it isn't a
  natural place to send a follow-up via cloud-to-cloud handoff
  (responding to the prompt on the original run is the right path).
  Added a sentence to the prereq calling that out explicitly so
  readers don't try to hand off a blocked run.

Validation
- python3 .agents/skills/style_lint/style_lint.py --changed -> 0 issues.
- python3 .agents/skills/check_for_broken_links/check_links.py
  --internal-only -> 0 broken (2,439 internal links, 321 files).

Co-Authored-By: Oz <oz-agent@warp.dev>
Two small consistency fixes caught on a third audit round:

- L29 "An ended cloud agent run" prereq: "Blocked runs ... aren't
  continued through cloud-to-cloud handoff" -> "...can't be continued
  via cloud-to-cloud handoff". Makes the carve-out parallel with the
  very next sentence ("Very old runs ... can't be continued via
  handoff"), and reads more directly than "aren't continued through".
- L30 "A snapshot from the prior session" prereq: "the run still
  continues -- it just starts without restored workspace state" ->
  "the run still continues, just without restored workspace state".
  The em dash + "it just starts" was colloquial and a bit redundant
  ("continues" and "starts" describe the same event); the comma-led
  adjective phrase is cleaner.

Validation
- python3 .agents/skills/style_lint/style_lint.py --changed -> 0 issues.
- python3 .agents/skills/check_for_broken_links/check_links.py
  --internal-only -> 0 broken (2,439 internal links, 321 files).

Co-Authored-By: Oz <oz-agent@warp.dev>
The "cross-cutting sidebar PR" that the original PR description referred
to doesn't exist — none of the orchestration-launch content is currently
registered in `src/sidebar.ts`. PR #84 (multi-agent) doesn't touch the
sidebar either; only PR #86 (memory) adds its own entries. Following
that pattern: register the three handoff pages here so they actually
appear in the docs sidebar when this branch merges.

src/sidebar.ts
- Added a new "Handoff" collapsible group inside the "Oz Cloud Agents
  & Orchestration" topic, slotted right after "Viewing cloud agent
  runs" since that's the closest thematic neighbor (it covers
  `Continue locally` / `/continue-locally`, the cloud-to-local path).
  The group contains:
    - Overview -> agent-platform/cloud-agents/handoff
    - Local to cloud -> agent-platform/cloud-agents/handoff/local-to-cloud
    - Cloud to cloud -> agent-platform/cloud-agents/handoff/cloud-to-cloud
  Mirrors the existing collapsible-group shape used by Triggers,
  Integrations, and Self-hosting in the same section.

src/content/docs/agent-platform/cloud-agents/handoff/cloud-to-cloud.mdx
- "(from the conversation details panel or the end-of-run tombstone)"
  -> "(from the conversation details panel or the artifacts shown
  after the run)". "Tombstone" is the internal code-level term for
  the post-run view (`shared_session/conversation_ended_tombstone_view.rs`).
  Even though it shows up in telemetry-event descriptions in
  `privacy.mdx`, it's not natural user-facing copy. Switched to a
  plainer reference to the artifacts surfaced after the run.

Validation
- python3 .agents/skills/style_lint/style_lint.py --changed -> 0 issues
  on the files this PR touches. (The pre-existing pricing-faqs.mdx
  warnings are out of scope.)
- python3 .agents/skills/check_for_broken_links/check_links.py
  --internal-only -> 0 broken (2,440 links, 322 files).
- `npm run build` fails on an UNRELATED orphan page
  (`agent-platform/cloud-agents/agents.mdx` is not registered in the
  sidebar). That page was added earlier on this branch by a different
  PR and is pre-existing breakage on `hyc/orch/handoff` — my edits
  don't touch it.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen merged commit b6ff965 into hyc/orchestration-launch May 19, 2026
3 of 4 checks passed
@hongyi-chen hongyi-chen deleted the hyc/orch/handoff branch May 19, 2026 06:07
hongyi-chen added a commit that referenced this pull request May 19, 2026
…ries (#101)

* Audit pass 3: Memory + Handoff polish, cross-references, glossary entries

Final audit pass over hyc/orchestration-launch ahead of the rollout PR.
Covers the deltas from #86 (Agent Memory research preview) and #85
(local\u2194cloud handoff) that landed after audit pass 2.

Sentence case / Title Case:
- capabilities/skills.mdx:414: '## Suggested Skills from Agent Memory'
  -> '## Suggested skills from Agent Memory'. The section body uses
  lowercase 'skill drafts', so the heading should match. Also clears
  the one new style_lint warning introduced by #86.

Stale config:
- agent-platform/agent-memory/index.mdx: drop '(Research Preview)' from
  the frontmatter sidebar.label. sidebar.ts already overrides the label
  to 'Agent Memory' under a group named 'Memory (Research Preview)';
  the duplicate annotation was dead config.

Cross-link gaps from neighboring pages:
- cloud-agents/viewing-cloud-agent-runs.mdx (the '5. Fork the session
  to your local Warp' section): add a one-line reference to the new
  Handoff overview, so the cloud-to-local direction is discoverable
  from the broader handoff doc.
- cloud-agents/managing-cloud-agents.mdx: add a Related pages section
  that links to the Handoff overview and the other neighbors that
  weren't surfaced before.
- local-agents/cloud-conversations.mdx (Related features): add a link
  to the Handoff overview, since handoff relies on cloud-synced
  conversations.

Style:
- cloud-agents/handoff/index.mdx:30: drop 'just' from 'not just read
  about it' -> 'not only read about it'. Same ableist-language pattern
  audit pass 2 cleaned up elsewhere.

Glossary additions:
- .agents/references/terminology.md (Agent concepts) + AGENTS.md
  (Core features): add canonical entries for 'Agent Memory', 'memory
  store', and 'Handoff' so the launch terms ship with documented
  capitalization rules ('Agent Memory' Title Case as a feature;
  'memory store' lowercase common noun; 'Handoff' Title Case as the
  feature, lowercase 'hand off' / 'handed off' as the verb).

Validation:
- check_links --internal-only: 0 broken across 2,543 internal links
  (up 6 from the 2,537 baseline, matching the 6 new cross-refs).
- style_lint --changed: 14 warnings (one fewer than baseline; the
  skills.mdx Title Case heading is no longer flagged). The remaining
  warnings are all pre-existing proper-name false positives.
- npm run build: 330 pages built; sidebar still resolves all slugs;
  new anchor reference (#5-fork-the-session-to-your-local-warp) resolves.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Restore (Research Preview) suffix in agent-memory sidebar.label

Revert the sidebar.label change from the audit pass. Keeping the
research-preview annotation in the frontmatter as a defensive fallback
in case the sidebar.ts override is ever removed.

Co-Authored-By: Oz <oz-agent@warp.dev>

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants